.\"	$OpenBSD: nm.1,v 1.27 2015/05/17 20:19:08 guenther Exp $
.\"	$NetBSD: nm.1,v 1.3 1995/08/31 23:41:58 jtc Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)nm.1	8.1 (Berkeley) 6/6/93
.\"
.Dd $Mdocdate: May 17 2015 $
.Dt NM 1
.Os
.Sh NAME
.Nm nm
.Nd display name list (symbol table)
.Sh SYNOPSIS
.Nm nm
.Op Fl aCDegnoprsuw
.Op Ar
.Sh DESCRIPTION
The symbol table (name list) of each object in
.Ar file(s)
is displayed.
If a library (archive) is given,
.Nm
displays a list for each
object archive member.
If
.Ar file
is not present,
.Nm
searches for the file
.Pa a.out
and displays its symbol table if it exists.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a
Display symbol table entries inserted for use by debuggers.
.It Fl C
Decode low-level symbol names.
This involves removing extra underscores and making C++ function names readable.
.It Fl D
Display the dynamic symbol table instead of the normal symbol table.
.It Fl e
Output extended information, that is `w' for weak symbols, `f' for
function-like symbols, and `o' for object-like symbols.
.It Fl g
Restrict display to external (global) symbols.
.It Fl n
Present results in numerical order.
.It Fl o
Display full path or library name of object on every line.
.It Fl p
Do not sort at all.
.It Fl r
Reverse order sort.
.It Fl s
Show archive index.
.It Fl u
Display undefined symbols only.
.It Fl w
Warn about non-object archive members.
Normally,
.Nm nm
will silently ignore all archive members which are not
object files.
.El
.Pp
Each symbol name is preceded by its value (a blank field if the symbol
is undefined) and one of the following letters:
.Pp
.Bl -tag -width Ds -compact -offset indent
.It Fl
debugger symbol table entries (see the
.Fl a
option)
.It Li A
absolute
.It Li B
bss or tbss segment symbol
.It Li C
common symbol
.It Li D
data or tdata segment symbol
.It Li F
file name
.It Li R
read-only data segment symbol
.It Li T
text segment symbol
.It Li U
undefined
.It Li W
weak symbol
.El
.Pp
If the symbol is local (non-external), the type letter is in lower case.
The output is sorted alphabetically.
.Sh SEE ALSO
.Xr ar 1 ,
.Xr size 1 ,
.Xr ar 5 ,
.Xr elf 5
.Sh STANDARDS
The
.Nm
utility is part of the
.St -p1003.1-2008
specification;
this implementation is largely incompatible with that standard.
.Sh HISTORY
An
.Nm nm
command appeared in
.At v6 .
